home *** CD-ROM | disk | FTP | other *** search
/ Mac Magazin/MacEasy 18 / Mac Magazin and MacEasy Magazine CD - Issue 18.iso / Online / XTML v1.2.1 / XTML Readme < prev   
Text File  |  1995-12-08  |  12KB  |  215 lines

  1.                                           eXcel Table Markup Language
  2.                                                                                                                              version 1.2.1
  3.  
  4. Copyright ©1995, by Ken Sayward.  All rights reserved.
  5. Please send questions, comments and suggestions to Sayward@ae.vitro.com
  6.  
  7. The latest version and documentation can be found on my AOL web page at http://users.aol.com/ksayward/
  8.  
  9. Description
  10. XTML was created for one basic purpose:  To create HTML Tables quickly and easily. If you have data in a Microsoft Excel spreadsheet, XTML can convert it into a table ready for inclusion in your web site - with one command. You can use the normal excel formatting commands to assign font styles and text alignment, and XTML will produce the necessary HTML tags to reproduce the table on the web. The resulting HTML source is saved into a text file, where you can edit and fine-tune it just as you would any of your other web files.
  11.  
  12. What you need
  13. • Microsoft Excel version 5.0 or later (Macintosh or Windows versions).
  14. • 7 bucks. This is shareware :-)
  15.  
  16.    Please send a check or money order for $7.00 (US) to:
  17.  
  18.      Ken Sayward
  19.      155 Flanders Rd
  20.      Niantic, CT 06333
  21.      USA
  22.  
  23. I did spend quite a bit of time writing this to be as flexible as possible; If you use it for more than a few days, please register it. If you send me your email address along with the 7 bucks, I'll make sure you get notification of the latest versions when anything changes. 
  24.  
  25. Installation
  26. Macintosh - 'XTML Add-In' is an Add-in module for Microsoft Excel v5.0 or later. Just drop it in the 'Excel Startup Folder (5)' folder inside your preferences folder within the system folder. If you don't have a folder called 'Excel Startup Folder (5)', simply make one and drop the XTML Add-in file into it. The file must be named 'XTML Add-In'.
  27.  
  28. Windows - 'XTML.XLA' is an Add-in module for Microsoft Excel v5.0 or later. Just drop it in the '\XLStart' subdirectory inside your Excel 5 directory. The file must be named 'XTML.XLA'.
  29.  
  30. Note that the add-in file is binary compatible across Mac and Windows platforms. The only requirement is that the file be named according to the platform it is used on.
  31.  
  32. That's it. The next time you launch Excel, you'll have a new item in the 'Tools' menu, called "XTML", with a few subitems (explained below).
  33.  
  34. How it works
  35. 1) Create your spreadsheet table in Excel (what better place to maintain tabular data?)
  36. 2) Format the cells if necessary.
  37.  
  38.     XTML will honor the following, on a cell-by-cell basis:
  39.     - bold cells will get marked up as <strong> - (default tag can be changed - see preferences below).
  40.     - italic cells will get marked up as <em> (emphasis) - (default tag can be changed - see preferences below).
  41.     - bold italic cells will get both <strong> and <em> tags - (default tags can be changed - see preferences below).
  42.     - Centered cells will get <td align=center> tags
  43.     - Right-aligned cells will get <td align=right> tags
  44.     - Numeric formats (currency, commas, percent, etc.)
  45.     - Numeric cells will default to right aligned, where no specific alignment is applied to the cell.
  46.     - Cells formatted with Excel's "center across selection" will get the appropriate COLSPAN tag.
  47.  
  48. 3) Position the Excel cursor in any of the cells within the target table
  49. 4) Select 'Convert to HTML Table…' from the 'XTML' pop-up menu in the 'Tools' menu. You'll see the following dialog:
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73. HTML Table Options explained
  74. • Input Range. The range of excel cells you would like to create HTML source for. Excel will do a best guess based on the active cell when you select "Convert to HTML Table…" from the menu. You can change the input range by selecting the cells you wish to work with, while the dialog box is open.
  75.  
  76. • Window Title. The text which will appear in the window title when the page is viewed with a web browser. The default is the name of the Excel worksheet.
  77.  
  78. • Table Caption. The text which will appear above the table, with <caption> & <h2> tags. The default is the name of the Excel worksheet. You can change the header tags to whatever you'd like in the resulting .html file. It seemed to me that <h1> was a bit of overkill.
  79.  
  80. • Output Filename. The filename for the resulting text file. The default is the name of the Excel worksheet, with ".html" appended to it.  Note: the file will be automatically saved to the current active folder as shown in Excel when you do a 'save as…' or 'open…'.
  81.  
  82. • Header and Cell Formatting. Determines the look of the resulting HTML source.
  83.    - Default: Marks up the first row of the table with <th> tags; no other formatting.
  84.    - Use Excel Formatting: Marks up all cells according to their format and alignment as described in 'How it works'.
  85.    - None: No special formatting at all. Only marks up the table with <tr> and <td> tags.
  86.  
  87. • Include Table Border.  Just what it says.
  88.  
  89. • Borders on blank cells.  If you check this option, XTML will insert “ ” into HTML table cells, so that those cells get borders around them as well. Only applies when the ‘Include Table Border’ option is selected.
  90.  
  91. • Border width [  ] pixels.  Size of the table border (if enabled). Valid range is 1 - 25. Values outside of this range will be reset to 1 (the default).
  92.  
  93. • Table Width [  ] %.  Specify the percentage of the width of the web page to display the table. For example, if you enter 50%, the table will be centered on the page but only use half of the current page width. Default is 100%.
  94.  
  95.  
  96. Setting Preferences
  97. XTML v1.1.0 and higher maintains a file in your 'preferences' folder called 'XTML Prefs' (in the Windows version, the prefs file is called 'XTMLPREF.txt' and is stored in the same directory as the Excel application file). This file is created automatically the first time you select one of the XTML menu items. It is initially created with default values, but you can change them as follows. Select 'Preferences…' from the 'XTML' pop-up menu in the 'Tools' menu. You'll see the following dialog:
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121. XTML Preferences explained
  122. • Horizontal Alignment. Check this box to tell XTML to preserve the alignment of cells as formatted in Excel.
  123.  
  124. • Numbers default to right aligned. Check this box to tell XTML to automatically tag numeric cells as right aligned, unless another alignment has been applied to the cell.
  125.  
  126. • Numeric Formats. Check this box to tell XTML to preserve the formatting of numeric cells, such as currency, commas, percentages, etc.
  127.  
  128. • Font Styles. Check these boxes to tell XTML to preserve the font style of cells as formatted in Excel. In addition, you can specify which tags to use for the (currently) three styles supported. The defaults are shown in the dialog box above.
  129. Caution:If you change the tags for bolditalic, and you still use two different tags (like <b><i>), be careful to get the closing tags in the correct order.
  130.  
  131. • Display file format warnings after processing. Check this box so that XTML will remind the user about the fact that output files must be saved as 'formatted text (space delimited)'. If this is unchecked, no warning dialogs will be displayed.
  132.  
  133. • Reset Defaults. Click this button to reset the default values for all options in this dialog box.
  134.  
  135.  
  136.  
  137. Version history
  138. Version 1.0.0 - 20 Nov 95 
  139. - Initial release
  140.  
  141. Version 1.0.1 - 21 Nov 95
  142. - Fixed a bug where the initial <body> tag wasn't getting written to the output file.
  143. - Fixed a bug where table rows with HTML source greater than 255 characters were being truncated.
  144.    This was fixed by changing the output style to a more 'vertical' orientation (more carriage returns).
  145.    The downside is that the output filesize is slightly larger.
  146.    The upside is that the output file is probably easier to read and fine-tune.
  147. - Changed the text of the finishing alert message to refer to the output file as 'formatted text (space delimited)'.
  148.  
  149. Version 1.0.2 - 22 Nov 95
  150. - Cleaned up the VBA code to make it more modular, and speed things up.
  151.    This should make it easier to add more functionality in the future.
  152.  
  153. Version 1.0.3 - 24 Nov 95
  154. - Re-wrote the output code to write directly to a new file. Previously, the output was being written to a scratch worksheet within the XTML Add-In, then being copied and pasted into the new output file. The new method speeds things up a bit, and makes the add-in file smaller. It also eliminates the possibility that the copy/paste operation would generate a memory alert.
  155.  
  156. Version 1.0.4 - 25 Nov 95
  157. - Now preserves Excel's numeric formats.
  158. - Numeric cells will default to right aligned.
  159.  
  160. Version 1.1.1 - 28 Nov 95
  161. - Added an 'XTML Prefs' file, which automatically gets created in your preferences folder.
  162.    Allows user selection of formatting tags for bold, italic, and bolditalic cells
  163.    stores user definition of which cell attributes to preserve when converting from Excel to HTML
  164. - Changed the custom menu definitions
  165.    Now creates a submenu in the 'Tools' menu, but only when a Worksheet is the active sheet.
  166. - Added an About… box.
  167. - Added shareware registration code.
  168.  
  169. Version 1.1.2 - 28 Nov 95
  170. - Added support for the Windows version of Excel.
  171.    The add-in file must be renamed as 'XTML.XLA'.
  172.    The prefs file ('XTMLPref.txt') is stored in the Excel application directory (Windows version only).
  173. - Optimized some of the code for handling preferences. Speeds up the display of dialog boxes.
  174.  
  175. Version 1.1.3 - 30 Nov 95
  176. - Numbers formatted as currency or accounting were not getting default right alignment. Fixed.
  177. - Changed the calculation of the default input range:
  178.    If the current selection is exactly one cell, then XTML attempts to determine the desired input range using the 
  179.    'CurrentRegion' property. If the current selection is more than one cell, then the current selection is used.
  180. - Some 'high-ASCII' characters were not displaying properly in Excel for Windows. Fixed.
  181. - Changed file suffix default to '.htm' when running on Excel for Windows.
  182.    Default is still '.html' on the Mac.
  183. - Registration dialog now displays reliably when requested from 'About...' dialog.
  184.  
  185. Version 1.1.4 - 1 Dec 95
  186. - Fixed a problem with the 'XTML Prefs' file for non-english versions of Excel.
  187. - Added an option to add borders to blank cells.
  188.    XTML adds a " " (a nonbreaking space) in the HTML for that cell.
  189. - Changed the table caption to acually use the <caption> tag.  duh. :-)
  190.  
  191. Version 1.1.5 - 4 Dec 95
  192. - Added a substitution routine for accented and other special characters.
  193.    XTML now substitutes the appropriate "&xxxx;" codes. For example, the "é" character is replaced with "é"
  194.    This substitution only occurs in the HTML output file.
  195.  
  196. Version 1.2.0 - 8 Dec 95
  197. - Added support for COLSPAN. Cells formatted with Excel's "center across selection" will get COLSPAN tags.
  198. - Revised the output file saving routine to give more control over where the HTML file gets saved.
  199. - Added a preference to suppress the file format warning after XTML processing is complete.
  200.  
  201. Version 1.2.1 - 8 Dec 95
  202. - Fixed a bug in the prefs code when reading old prefs files (this one slipped through earlier today).
  203.  
  204. Future plans
  205. Pretty soon (if I can do this without adding too much processing overhead):
  206.   • Set 'row-level' alignment in the <tr> tags, if it would reduce the repetition in the <td> tags.
  207.  
  208. A little later (maybe):
  209.   • Handle 'ROWSPAN'
  210.   • Nested tables.
  211.  
  212.  
  213. Distribution
  214. This software is shareware. Permission is hereby granted for non-commercial distribution of unmodified copies of this software, so long as this documentation is included. For information about including this software on compilation CD-ROMs or disks, please contact the author.
  215.